| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

ScriptObjectReference.h
1 // ScriptObjectReference.h
3 //
5
6 namespace nkScripts
7 {
11 struct ScriptObjectReferenceStruct
12 {
13 ScriptObjectInterpreterReference* _reference = nullptr ;
14
15 int _counter = 1 ;
16 } ;
17 }
18
19 namespace nkScripts
20 {
29 class ScriptObjectReference final
30 {
31 public :
32
36 ScriptObjectReference () noexcept ;
42 ScriptObjectReference (ScriptObjectInterpreterReference* reference) noexcept ;
48 ScriptObjectReference (const ScriptObjectView& other) noexcept ;
54 ScriptObjectReference (const ScriptObjectReference& other) noexcept ;
60 ScriptObjectReference (ScriptObjectReference&& other) noexcept ;
64 ~ScriptObjectReference () ;
65
66 // Getters
70 ScriptObjectInterpreterReference* getInterpreterReference () const ;
74 FUNCTION_PARAMETER_TYPE getType () const ;
78 bool isValid () const ;
79
80 // Operators
87 ScriptObjectReference& operator= (const ScriptObjectView& other) noexcept ;
94 ScriptObjectReference& operator= (const ScriptObjectReference& other) noexcept ;
101 ScriptObjectReference& operator= (ScriptObjectReference&& other) noexcept ;
102 } ;
103 }
nkScripts::ScriptObjectReference::getInterpreterReference
ScriptObjectInterpreterReference * getInterpreterReference() const
nkScripts
Encompasses all API of component NilkinsScripts.
Definition: Environment.h:7
nkScripts::ScriptObjectInterpreterReference
Base interface for interpreter specific reference over script object.
Definition: ScriptObjectInterpreterReference.h:14
nkScripts::ScriptObjectReferenceStruct::_counter
int _counter
The counter for reference counting.
Definition: ScriptObjectReference.h:15
nkScripts::ScriptObjectReference::isValid
bool isValid() const
nkScripts::ScriptObjectReference
A reference over an object in the scripting environment.
Definition: ScriptObjectReference.h:30
nkScripts::ScriptObjectReference::getType
FUNCTION_PARAMETER_TYPE getType() const
nkScripts::ScriptObjectReference::ScriptObjectReference
ScriptObjectReference() noexcept
nkScripts::ScriptObjectReferenceStruct::_reference
ScriptObjectInterpreterReference * _reference
The interpreter specific reference data.
Definition: ScriptObjectReference.h:13
nkScripts::ScriptObjectView
A view over an object in the scripting environment.
Definition: ScriptObjectView.h:16
nkScripts::FUNCTION_PARAMETER_TYPE
FUNCTION_PARAMETER_TYPE
Describes a variable type.
Definition: FunctionParameterType.h:12
nkScripts::ScriptObjectReferenceStruct
Holds information about a reference.
Definition: ScriptObjectReference.h:12